<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PxPvdTransport Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classPxPvdTransport.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classPxPvdTransport-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PxPvdTransport Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__pvd.html">Pvd</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="classPxPvdTransport.html" title="PxPvdTransport is an interface representing the data transport mechanism. This class defines all serv...">PxPvdTransport</a> is an interface representing the data transport mechanism. This class defines all services associated with the transport: configuration, connection, reading, writing etc. It is owned by the application, and can be realized as a file or a socket (using one-line PxDefault&lt;...&gt; methods in PhysXExtensions) or in a custom implementation. This is a class that is intended for use by PVD, not by the application, the application entry points are <a class="el" href="classPxPvd.html" title="PxPvd is the top-level class for the PVD framework, and the main customer interface for PVD configura...">PxPvd</a> and PvdClient.  
 <a href="classPxPvdTransport.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="PxPvdTransport_8h_source.html">PxPvdTransport.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1871093d413951ee1d633d8372299162"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdTransport.html#a1871093d413951ee1d633d8372299162">connect</a> ()=0</td></tr>
<tr class="separator:a1871093d413951ee1d633d8372299162"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf8e898a2f3b47581545e166015218b4"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdTransport.html#acf8e898a2f3b47581545e166015218b4">disconnect</a> ()=0</td></tr>
<tr class="separator:acf8e898a2f3b47581545e166015218b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae40dca8902fded07da0968be3eece05d"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdTransport.html#ae40dca8902fded07da0968be3eece05d">isConnected</a> ()=0</td></tr>
<tr class="separator:ae40dca8902fded07da0968be3eece05d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0eebe29369524d988556768b0e744009"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdTransport.html#a0eebe29369524d988556768b0e744009">write</a> (const uint8_t *inBytes, uint32_t inLength)=0</td></tr>
<tr class="separator:a0eebe29369524d988556768b0e744009"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe35ed2fab8ee24cc75fa5ae4923125e"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classPxPvdTransport.html">PxPvdTransport</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdTransport.html#abe35ed2fab8ee24cc75fa5ae4923125e">lock</a> ()=0</td></tr>
<tr class="separator:abe35ed2fab8ee24cc75fa5ae4923125e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0b2edc04c6a7cbb45ef669e08d0e890"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdTransport.html#ab0b2edc04c6a7cbb45ef669e08d0e890">unlock</a> ()=0</td></tr>
<tr class="separator:ab0b2edc04c6a7cbb45ef669e08d0e890"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46a1dc45e8cf27e34f717ff2cb587fa6"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdTransport.html#a46a1dc45e8cf27e34f717ff2cb587fa6">flush</a> ()=0</td></tr>
<tr class="separator:a46a1dc45e8cf27e34f717ff2cb587fa6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21db3b3932ca803b5232f34c503f4f4e"><td class="memItemLeft" align="right" valign="top">virtual uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdTransport.html#a21db3b3932ca803b5232f34c503f4f4e">getWrittenDataSize</a> ()=0</td></tr>
<tr class="separator:a21db3b3932ca803b5232f34c503f4f4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29b4aa7a8ad3566b8a4ef2839de2cfd9"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdTransport.html#a29b4aa7a8ad3566b8a4ef2839de2cfd9">release</a> ()=0</td></tr>
<tr class="separator:a29b4aa7a8ad3566b8a4ef2839de2cfd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a969df5be18683a8805a24a6fa4699bc9"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdTransport.html#a969df5be18683a8805a24a6fa4699bc9">~PxPvdTransport</a> ()</td></tr>
<tr class="separator:a969df5be18683a8805a24a6fa4699bc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classPxPvdTransport.html" title="PxPvdTransport is an interface representing the data transport mechanism. This class defines all serv...">PxPvdTransport</a> is an interface representing the data transport mechanism. This class defines all services associated with the transport: configuration, connection, reading, writing etc. It is owned by the application, and can be realized as a file or a socket (using one-line PxDefault&lt;...&gt; methods in PhysXExtensions) or in a custom implementation. This is a class that is intended for use by PVD, not by the application, the application entry points are <a class="el" href="classPxPvd.html" title="PxPvd is the top-level class for the PVD framework, and the main customer interface for PVD configura...">PxPvd</a> and PvdClient. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a969df5be18683a8805a24a6fa4699bc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a969df5be18683a8805a24a6fa4699bc9">&#9670;&nbsp;</a></span>~PxPvdTransport()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual PxPvdTransport::~PxPvdTransport </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1871093d413951ee1d633d8372299162"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1871093d413951ee1d633d8372299162">&#9670;&nbsp;</a></span>connect()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool PxPvdTransport::connect </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Connects to the Visual Debugger application. return True if success </p>

</div>
</div>
<a id="acf8e898a2f3b47581545e166015218b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf8e898a2f3b47581545e166015218b4">&#9670;&nbsp;</a></span>disconnect()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxPvdTransport::disconnect </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Disconnects from the Visual Debugger application. If we are still connected, this will kill the entire debugger connection. </p>

</div>
</div>
<a id="a46a1dc45e8cf27e34f717ff2cb587fa6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46a1dc45e8cf27e34f717ff2cb587fa6">&#9670;&nbsp;</a></span>flush()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxPvdTransport::flush </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>send any data and block until we know it is at least on the wire. </p>

</div>
</div>
<a id="a21db3b3932ca803b5232f34c503f4f4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21db3b3932ca803b5232f34c503f4f4e">&#9670;&nbsp;</a></span>getWrittenDataSize()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual uint64_t PxPvdTransport::getWrittenDataSize </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Return size of written data. </p>

</div>
</div>
<a id="ae40dca8902fded07da0968be3eece05d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae40dca8902fded07da0968be3eece05d">&#9670;&nbsp;</a></span>isConnected()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool PxPvdTransport::isConnected </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Return if connection to PVD is created. </p>

</div>
</div>
<a id="abe35ed2fab8ee24cc75fa5ae4923125e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe35ed2fab8ee24cc75fa5ae4923125e">&#9670;&nbsp;</a></span>lock()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classPxPvdTransport.html">PxPvdTransport</a>&amp; PxPvdTransport::lock </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a29b4aa7a8ad3566b8a4ef2839de2cfd9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29b4aa7a8ad3566b8a4ef2839de2cfd9">&#9670;&nbsp;</a></span>release()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxPvdTransport::release </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="ab0b2edc04c6a7cbb45ef669e08d0e890"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0b2edc04c6a7cbb45ef669e08d0e890">&#9670;&nbsp;</a></span>unlock()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxPvdTransport::unlock </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a0eebe29369524d988556768b0e744009"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0eebe29369524d988556768b0e744009">&#9670;&nbsp;</a></span>write()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool PxPvdTransport::write </td>
          <td>(</td>
          <td class="paramtype">const uint8_t *&#160;</td>
          <td class="paramname"><em>inBytes</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>inLength</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>write bytes to the other endpoint of the connection. should lock before witre. If an error occurs this connection will assume to be dead. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxPvdTransport_8h_source.html">PxPvdTransport.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classPxPvdTransport.html">PxPvdTransport</a></li>
    <li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
  </ul>
</div>
</body>
</html>
